/*
 * Copyright (c) 2005-2009 Substance Kirill Grouchnikov. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 *  o Redistributions of source code must retain the above copyright notice, 
 *    this list of conditions and the following disclaimer. 
 *     
 *  o Redistributions in binary form must reproduce the above copyright notice, 
 *    this list of conditions and the following disclaimer in the documentation 
 *    and/or other materials provided with the distribution. 
 *     
 *  o Neither the name of Substance Kirill Grouchnikov nor the names of 
 *    its contributors may be used to endorse or promote products derived 
 *    from this software without specific prior written permission. 
 *     
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */
package org.jvnet.substance.painter.noise;

/**
 * Base class for stretch noise filters. This class is part of officially
 * supported API.
 * 
 * @author Kirill Grouchnikov.
 */
public abstract class BaseNoiseFilter implements NoiseFilter {
	/**
	 * Stretch factor for X axis.
	 */
	protected double xFactor;

	/**
	 * Stretch factor for Y axis.
	 */
	protected double yFactor;

	/**
	 * Stretch factor for Z axis.
	 */
	protected double zFactor;

	/**
	 * Stretch factor for value.
	 */
	protected double valueFactor;

	/**
	 * Trigonometry function.
	 */
	protected TrigKind trigKind;

	/**
	 * Creates a new base filter.
	 * 
	 * @param xFactor
	 *            Stretch factor for X axis.
	 * @param yFactor
	 *            Stretch factor for Y axis.
	 * @param zFactor
	 *            Stretch factor for Z axis.
	 * @param valueFactor
	 *            Stretch factor for value.
	 * @param trigKind
	 *            Trigonometry function.
	 */
	public BaseNoiseFilter(double xFactor, double yFactor, double zFactor,
			double valueFactor, TrigKind trigKind) {
		this.xFactor = xFactor;
		this.yFactor = yFactor;
		this.zFactor = zFactor;
		this.valueFactor = valueFactor;
		this.trigKind = trigKind;
	}
}
